Skip to content

doc(Icon): add Icon sample code #5278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Feb 2, 2025
Merged

doc(Icon): add Icon sample code #5278

merged 3 commits into from
Feb 2, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 2, 2025 •
edited by sourcery-ai bot
Loading

add Icon sample code

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #5277

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Documentation:

  • Add sample code for using icons in the documentation.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 2, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request adds sample code for displaying GitHub icons using various icon libraries. The sample code demonstrates how to use the different icon components with a GitHub icon.

Class diagram showing icon components and their usage

classDiagram
    class AntDesignIcon {
      +Category: AntDesignIconCategory
      +Name: string
    }
    class ElementIcon {
      +Name: string
    }
    class ByteDanceIcon {
      +Name: string
    }
    class OctIcon {
      +Name: string
    }
    note for AntDesignIcon "Updated to show GitHub icon"
    note for ElementIcon "Updated to show upload icon"
    note for ByteDanceIcon "Updated to show GitHub icon"
    note for OctIcon "Updated to show GitHub icon"
Loading

File-Level Changes

Change Details Files
Added sample code for displaying GitHub icons using AntDesignIcons.
  • Added a div containing the AntDesignIcon component with the github icon.
  • Added a Pre component containing the AntDesignIcon component with the github icon.
 src/BootstrapBlazor.Server/Components/Samples/Icons/AntDesignIcons.razor
Added sample code for displaying GitHub icons using BootstrapIcons.
  • Added a div containing the i component with the github icon.
  • Added a Pre component containing the i component with the github icon.
 src/BootstrapBlazor.Server/Components/Samples/Icons/BootstrapIcons.razor
Added sample code for displaying GitHub icons using ElementIcons.
  • Added a div containing the ElementIcon component with the upload-filled icon.
  • Added a Pre component containing the ElementIcon component with the upload-filled icon.
 src/BootstrapBlazor.Server/Components/Samples/Icons/ElementIcons.razor
Added sample code for displaying GitHub icons using FAIcons.
  • Added a div containing the i component with the github icon.
  • Added a Pre component containing the i component with the github icon.
 src/BootstrapBlazor.Server/Components/Samples/Icons/FAIcons.razor
Added sample code for displaying GitHub icons using IconParks.
  • Added a div containing the ByteDanceIcon component with the github icon.
  • Added a Pre component containing the ByteDanceIcon component with the github icon.
 src/BootstrapBlazor.Server/Components/Samples/Icons/IconParks.razor
Added sample code for displaying GitHub icons using MaterialDesignIcons.
  • Added a div containing the i component with the github icon.
  • Added a Pre component containing the i component with the github icon.
 src/BootstrapBlazor.Server/Components/Samples/Icons/MaterialDesignIcons.razor
Added sample code for displaying GitHub icons using OctIcons.
  • Added a div containing the OctIcon component with the mark-github-16 icon.
  • Added a Pre component containing the OctIcon component with the mark-github-16 icon.
 src/BootstrapBlazor.Server/Components/Samples/Icons/OctIcons.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5277 Add Icon sample code ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Feb 2, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 2, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) February 2, 2025 04:27
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 2, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Feb 2, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.99%. Comparing base (e654d66) to head (d2d7a4a).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #5278   +/-   ##
=======================================
  Coverage   99.99%   99.99%           
=======================================
  Files         640      640           
  Lines       28781    28781           
  Branches     4092     4092           
=======================================
  Hits        28779    28779           
  Partials        2        2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang
Copy link
Member Author

ArgoZhang commented Feb 2, 2025

@sourcery-ai review

sourcery-ai[bot]
sourcery-ai bot approved these changes Feb 2, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using a GitHub icon in the ElementIcons example for consistency with other icon library examples
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang merged commit 73e6f95 into main Feb 2, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-icon branch February 2, 2025 04:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

v9.3.0

Development

Successfully merging this pull request may close these issues.

doc(Icon): add Icon sample code

2 participants

@ArgoZhang